Procurement APIs

GET procurement/imported-invoices

List of imported supplier invoices

HTTP method	GET
URI	https://api.rambase.net/procurement/imported-invoices
Supported formats	Xml, Html, Json (ex. $format=json)
Maximum page size ($top)	80
Custom fields	Custom fields supported
Successful HTTP status code	200
API resource identifier	2817, version 28

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional	Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional	Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional	After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional	Set the database/company for the request
$expand String, optional	Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional	Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional	Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$showCustomFields Boolean, optional	Set to "true" to include custom fields. Default value is false.
$top String, optional	Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional	Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional	Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional	Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional	Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

Active() Named filter	Active imported supplier invoices and credit notes
MyImportedInvoices() Named filter	Supplier invoices imported by current user
MyPurchaseOrders() Named filter	List of received invoices which has a reference to one of my purchase orders
PendingCorrection() Named filter	Imported supplier invoices pending corrections (status 6)
PendingForward() Named filter	Imported supplier invoices pending forward (Status 8)
PendingValidation() Named filter	Imported supplier invoices pending validation (status 2)
ScannedInvoices() Named filter	Imported supplier invoices which was scanned
AccountName String	The bank account name to the payment receiver.
AccountNumber String	The bank account number to the payment receiver.
BacklogObjectAssigneeUserId Integer	User identifier.
BuyersContactEmail String	E-mail of the RamBase contact.
BuyersContactName String	Name of the RamBase contact (legal entity or person).
BuyersContactPhone String	Phone number of the RamBase contact.
ContainingNoteText String	Show all received supplier invoices containing notes. Note that search will be for messages in company language, and not in user language.
Currency String	The currency to the imported supplier invoice.
DueDate Date	The due date of the imported supplier invoice. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
FeeAmount Decimal	Fee of the invoice.
FreightAmount Decimal	Freight of the invoice.
IBAN String	The international bank account number (IBAN) to the payment receiver.
ImportedAt Datetime	The date and time when the file was imported. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ImportedById Integer	User identifier.
ImportedSupplierInvoiceId Integer	Imported supplier invoice identifier.
IsCreditNote Boolean	Is the imported invoice from type credit note.
RegistrationDate Date	The issue date to the invoice. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Status Integer	Status of imported supplier invoice.
SubTotalAmount Decimal	Total net amount on the invoice.
SupplierLegalEntityIdentifier String	The enterprise number to the supplier.
SupplierName String	The name of the supplier.
SupplierReferenceId Integer	RamBase supplier identifier.
SuppliersReference String	The reference to the imported supplier invoice.
SuppliersReferenceNumber String	Supplier invoice number generated by the supplier invoicing system.
SWIFTCode String	The bank identification code (BIC) to the account to the payment receiver.
TotalAmount Decimal	Total net amount on the invoice.
VATAmount Decimal	Total amount of VAT on the invoice.
VATCurrency String	The currency used for VAT to the imported supplier invoice.
VATDate Date	The date when the VAT becomes accountable. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
VATRegistrationNumber String	VAT registration number of the company which should be used for the invoice or credit.

Read more about filters and sorting on how to use sortable parameters

AccountName String	The bank account name to the payment receiver
AccountNumber String	The bank account number to the payment receiver
BacklogObjectAssigneeUserId Integer	User identifier
BuyersContactEmail String	E-mail of the RamBase contact
BuyersContactName String	Name of the RamBase contact (legal entity or person)
BuyersContactPhone String	Phone number of the RamBase contact
ContainingNoteText String	Show all received supplier invoices containing notes. Note that search will be for messages in company language, and not in user language.
Currency String	The currency to the imported supplier invoice
DueDate Date	The due date of the imported supplier invoice
FeeAmount Decimal	Fee of the invoice
FreightAmount Decimal	Freight of the invoice
IBAN String	The international bank account number (IBAN) to the payment receiver
ImportedAt Datetime	The date and time when the file was imported
ImportedById Integer	User identifier
ImportedSupplierInvoiceId Integer	Imported supplier invoice identifier
IsCreditNote Boolean	Is the imported invoice from type credit note
RegistrationDate Date	The issue date to the invoice
Status Integer	Status of imported supplier invoice
SubTotalAmount Decimal	Total net amount on the invoice
SupplierLegalEntityIdentifier String	The enterprise number to the supplier
SupplierName String	The name of the supplier
SupplierReferenceId Integer	RamBase supplier identifier
SuppliersReference String	The reference to the imported supplier invoice
SuppliersReferenceNumber String	Supplier invoice number generated by the supplier invoicing system
SWIFTCode String	The bank identification code (BIC) to the account to the payment receiver
TotalAmount Decimal	Total net amount on the invoice
VATAmount Decimal	Total amount of VAT on the invoice
VATCurrency String	The currency used for VAT to the imported supplier invoice
VATDate Date	The date when the VAT becomes accountable
VATRegistrationNumber String	VAT registration number of the company which should be used for the invoice or credit.

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:

                                        <ImportedSupplierInvoices>
                                    

                                             <ImportedSupplierInvoice>
                                    

<ImportedSupplierInvoiceId

ImportedSupplierInvoiceId

Imported supplier invoice identifier

>{Integer}</ImportedSupplierInvoiceId>

<Status

Status

Status of imported supplier invoice

Possible domain values can be found here

>{Integer}</Status>

<RegistrationDate

RegistrationDate

The issue date to the invoice

>{Date}</RegistrationDate>

<SuppliersReference

SuppliersReference

The reference to the imported supplier invoice

>{String}</SuppliersReference>

<SuppliersReferenceNumber

SuppliersReferenceNumber

Supplier invoice number generated by the supplier invoicing system

>{String}</SuppliersReferenceNumber>

<Currency

Currency

The currency to the imported supplier invoice

>{String}</Currency>

<IsCreditNote

IsCreditNote

Is the imported invoice from type credit note

>{Boolean}</IsCreditNote>

<ImportedAt

ImportedAt

The date and time when the file was imported

>{Datetime}</ImportedAt>

<ImportedBy

ImportedBy

The PID to the user that imported the file

<UserId

UserId

User identifier

>{Integer}</UserId>

<Name

Name

Name of the user

>{String}</Name>

<FirstName

FirstName

First name of the user

>{String}</FirstName>

<UserLink

UserLink

User reference

>{String}</UserLink>

                                                  </ImportedBy>
                                    

                                                  <BuyersContact>
                                    

<Name

Name

Name of the RamBase contact (legal entity or person)

>{String}</Name>

<Phone

Phone

Phone number of the RamBase contact

>{String}</Phone>

<Email

Email

E-mail of the RamBase contact

>{String}</Email>

                                                  </BuyersContact>
                                    

                                                  <VATAccounting>
                                    

<Currency

Currency

The currency used for VAT to the imported supplier invoice

>{String}</Currency>

<Date

Date

The date when the VAT becomes accountable

>{Date}</Date>

<VATAmount

VATAmount

Total amount of VAT in VAT currency on the invoice

>{Decimal}</VATAmount>

<VATRegistrationNumber

VATRegistrationNumber

VAT registration number of the company which should be used for the invoice or credit.

>{String}</VATRegistrationNumber>

                                                  </VATAccounting>
                                    

                                                  <Totals>
                                    

<Currency

Currency

The currency to the imported supplier invoice

>{String}</Currency>

<FreightAmount

FreightAmount

Freight of the invoice

>{Decimal}</FreightAmount>

<FeeAmount

FeeAmount

Fee of the invoice

>{Decimal}</FeeAmount>

<SubTotalAmount

SubTotalAmount

Total net amount on the invoice

>{Decimal}</SubTotalAmount>

<VATAmount

VATAmount

Total amount of VAT on the invoice

>{Decimal}</VATAmount>

<TotalAmount

TotalAmount

Total net amount on the invoice

>{Decimal}</TotalAmount>

                                                  </Totals>
                                    

                                                  <Payment>
                                    

<DueDate

DueDate

The due date of the imported supplier invoice

>{Date}</DueDate>

<AccountName

AccountName

The bank account name to the payment receiver

>{String}</AccountName>

<AccountNumber

AccountNumber

The bank account number to the payment receiver

>{String}</AccountNumber>

<IBAN

IBAN

The international bank account number (IBAN) to the payment receiver

>{String}</IBAN>

<SWIFTCode

SWIFTCode

The bank identification code (BIC) to the account to the payment receiver

>{String}</SWIFTCode>

                                                  </Payment>
                                    

                                                  <Supplier>
                                    

<Name

Name

The name of the supplier

>{String}</Name>

<LegalEntityIdentifier

LegalEntityIdentifier

The enterprise number to the supplier

>{String}</LegalEntityIdentifier>

<SupplierReference

SupplierReference

The account to the supplier

<SupplierId

SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>

<FirstName

FirstName

Firstname/givenname if the supplier is a person

>{String}</FirstName>

<Name

Name

Name of supplier (name of company or surname/familyname/lastname of a person)

>{String}</Name>

<SupplierLink

SupplierLink

Supplier reference

>{String}</SupplierLink>

                                                       </SupplierReference>
                                    

                                                  </Supplier>
                                    

<BacklogObject

BacklogObject

Reference to a backlog object in RamBase based on information on the received supplier invoice.

<ObjectId

ObjectId

Identifier of the object

>{Integer}</ObjectId>

<ObjectType

ObjectType

Type of object

>{String}</ObjectType>

<Assignee

Assignee

The user who has been assigned to work with this object.

<UserId

UserId

User identifier

>{Integer}</UserId>

<Name

Name

Name of the user

>{String}</Name>

<FirstName

FirstName

First name of the user

>{String}</FirstName>

<UserLink

UserLink

User reference

>{String}</UserLink>

                                                       </Assignee>
                                    

<RamBaseKey

RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>

<ObjectLink

ObjectLink

API reference to the object

>{String}</ObjectLink>

                                                  </BacklogObject>
                                    

<ImportedSupplierInvoiceLink

ImportedSupplierInvoiceLink

Imported supplier invoice reference

>{String}</ImportedSupplierInvoiceLink>

                                             </ImportedSupplierInvoice>
                                    

<Paging

Paging

Detailed paging information for this list.

<PageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>

<Position

Position

Position of the first element in the list

>{Integer}</Position>

<Page

Page

Page index

>{Integer}</Page>

<FirstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>

<FirstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>

<PreviousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>

<PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>

<NextPageKey

NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>

<NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>

<LastPageKey

LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>

<LastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>

<Size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>

                                             </Paging>
                                    

                                        </ImportedSupplierInvoices>
                                    

{

                                             "importedSupplierInvoices": [
                                    

{

"importedSupplierInvoiceId

ImportedSupplierInvoiceId

Imported supplier invoice identifier

": "{Integer}",

"status

Status

Status of imported supplier invoice

Possible domain values can be found here

": "{Integer}",

"registrationDate

RegistrationDate

The issue date to the invoice

": "{Date}",

"suppliersReference

SuppliersReference

The reference to the imported supplier invoice

": "{String}",

"suppliersReferenceNumber

SuppliersReferenceNumber

Supplier invoice number generated by the supplier invoicing system

": "{String}",

"currency

Currency

The currency to the imported supplier invoice

": "{String}",

"isCreditNote

IsCreditNote

Is the imported invoice from type credit note

": "{Boolean}",

"importedAt

ImportedAt

The date and time when the file was imported

": "{Datetime}",

"importedBy

ImportedBy

The PID to the user that imported the file

": {

"userId

UserId

User identifier

": "{Integer}",

"name

Name

Name of the user

": "{String}",

"firstName

FirstName

First name of the user

": "{String}",

"userLink

UserLink

User reference

": "{String}"

},

                                                       "buyersContact": {
                                    

"name

Name

Name of the RamBase contact (legal entity or person)

": "{String}",

"phone

Phone

Phone number of the RamBase contact

": "{String}",

"email

Email

E-mail of the RamBase contact

": "{String}"

},

                                                       "vATAccounting": {
                                    

"currency

Currency

The currency used for VAT to the imported supplier invoice

": "{String}",

"date

Date

The date when the VAT becomes accountable

": "{Date}",

"vATAmount

VATAmount

Total amount of VAT in VAT currency on the invoice

": "{Decimal}",

"vATRegistrationNumber

VATRegistrationNumber

VAT registration number of the company which should be used for the invoice or credit.

": "{String}"

},

                                                       "totals": {
                                    

"currency

Currency

The currency to the imported supplier invoice

": "{String}",

"freightAmount

FreightAmount

Freight of the invoice

": "{Decimal}",

"feeAmount

FeeAmount

Fee of the invoice

": "{Decimal}",

"subTotalAmount

SubTotalAmount

Total net amount on the invoice

": "{Decimal}",

"vATAmount

VATAmount

Total amount of VAT on the invoice

": "{Decimal}",

"totalAmount

TotalAmount

Total net amount on the invoice

": "{Decimal}"

},

                                                       "payment": {
                                    

"dueDate

DueDate

The due date of the imported supplier invoice

": "{Date}",

"accountName

AccountName

The bank account name to the payment receiver

": "{String}",

"accountNumber

AccountNumber

The bank account number to the payment receiver

": "{String}",

"iBAN

IBAN

The international bank account number (IBAN) to the payment receiver

": "{String}",

"sWIFTCode

SWIFTCode

The bank identification code (BIC) to the account to the payment receiver

": "{String}"

},

                                                       "supplier": {
                                    

"name

Name

The name of the supplier

": "{String}",

"legalEntityIdentifier

LegalEntityIdentifier

The enterprise number to the supplier

": "{String}",

"supplierReference

SupplierReference

The account to the supplier

": {

"supplierId

SupplierId

RamBase supplier identifier

": "{Integer}",

"firstName

FirstName

Firstname/givenname if the supplier is a person

": "{String}",

"name

Name

Name of supplier (name of company or surname/familyname/lastname of a person)

": "{String}",

"supplierLink

SupplierLink

Supplier reference

": "{String}"

}

},

"backlogObject

BacklogObject

Reference to a backlog object in RamBase based on information on the received supplier invoice.

": {

"objectId

ObjectId

Identifier of the object

": "{Integer}",

"objectType

ObjectType

Type of object

": "{String}",

"assignee

Assignee

The user who has been assigned to work with this object.

": {

"userId

UserId

User identifier

": "{Integer}",

"name

Name

Name of the user

": "{String}",

"firstName

FirstName

First name of the user

": "{String}",

"userLink

UserLink

User reference

": "{String}"

},

"ramBaseKey

RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",

"objectLink

ObjectLink

API reference to the object

": "{String}"

},

"importedSupplierInvoiceLink

ImportedSupplierInvoiceLink

Imported supplier invoice reference

": "{String}"

}

],

"paging

Paging

Detailed paging information for this list.

": {

"pageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",

"position

Position

Position of the first element in the list

": "{Integer}",

"page

Page

Page index

": "{Integer}",

"firstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"firstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",

"previousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"previousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",

"nextPageKey

NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"nextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",

"lastPageKey

LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"lastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",

"size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"

}

}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

POST

Start import process by using a PEPPOL BIS Billing 3.0 file

Start the import process for a specific PEPPOL BIS Billing 3.0 file which is uploaded already in RamBase

AOP/100550

Possible error codes the response might return:

Error 101814 HTTP 404

Employee not found